.TH E1432_GET_TRIG_CORR 3 E1432
.SH NAME
e1432_get_trig_corr \- Get trigger to sample delay correction
.IX e1432_get_trig_corr(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_get_trig_corr(E1432ID hw, SHORTSIZ16 ID,
                                FLOATSIZ32 *trig_corr)
.cE
.SH DESCRIPTION

\fIe1432_get_trig_corr\fR gets the trigger to sample delay correction
for the current triggered measurement.  This delay is from the trigger event
to the next sample point.  It includes both the delay from trigger to the
next sample clock and the delay from trigger to the next decimated output
point.  It is normalized such that 1.0 is equivalent to one (decimated)
sample interval.

The delay returned by \fIe1432_get_trig_corr\fR is not absolute.
Other, fixed delays are present, which depend on setup conditions.  The
delay returned by this function is suitable for correcting time record
position such that the trigger event is accurately repeatable from sample
to sample.  One application of this function is correcting data prior to
time averaging.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained with a
call to \fIe1432_create_channel_group\fR, or the ID of a single channel.

\fItrig_corr\fR is a pointer to 32-bit float, and will be filled with the
current trigger to sample correction value.  This is the same parameter
as the trig_corr entry in the trailer.
.SH "RESET VALUE"
The value of \fIdelay\fR is not valid until after a triggered measurement.
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_set_append_status
.ad
